<?php
/**
 * Skyline :: Patterns & component framework
 * Copyright 2010-2011 Ian Unruh (Xerof3ar)
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace Skyline\Structure\Map;

use LogicException;
use Skyline\Structure\Map\Entry\EntryInterface;
use Skyline\Structure\Map\Entry\MutableEntry;

/**
 * Map that uses simple comparison to lookup entries
 * 
 * @author Ian Unruh (Xerof3ar) <ianunruh@gmail.com>
 * @since Class avaliable since release 1.0
 */
class SimpleMap extends AbstractEntryMap
{
	/**
	 * Returns true if a given key exists in this map
	 * 
	 * @param mixed $key
	 * @return bool
	 */
	public function containsKey($key)
	{
		foreach($this->entries as $entry) {
			if($key === $entry->getKey()) {
				return true;
			}
		}
		return false;
	}
	
	/**
	 * Removes a key from the map
	 * 
	 * @param mixed $key
	 * @return void
	 */
	public function remove($key)
	{
		foreach($this->entries as $offset => $entry) {
			if($key === $entry->getKey()) {
				unset($this->entries[$offset]);
				$this->changed = true;
				return;
			}
		}
	}
	
	/**
	 * Adds an entry to the map
	 * 
	 * @param EntryInterface $entry
	 * @return void
	 */
	protected function addEntry(EntryInterface $entry)
	{
		$this->entries[] = $entry;
	}
	
	/**
	 * Creates a new entry instance to be added to the map
	 * 
	 * @param mixed $key
	 * @param mixed $value
	 * @return EntryInterface
	 */
	protected function createEntry($key, $value)
	{
		return new MutableEntry($key, $value);
	}
	
	/**
	 * Returns an entry from the map by its key (if the key exists)
	 * 
	 * @param mixed $key
	 * @return EntryInterface
	 */
	protected function getEntry($key)
	{
		foreach($this->entries as $entry) {
			if($key === $entry->getKey()) {
				return $entry;
			}
		}
	}
}